SYMLINK
Section: System Calls (2)
Index
Return to Main Contents
BSD mandoc
BSD 4.2
NAME
symlink
- make symbolic link to a file
SYNOPSIS
Fd #include <unistd.h>
Ft int
Fn symlink const char *name1 const char *name2
DESCRIPTION
A symbolic link
Fa name2
is created to
Fa name1
( Fa name2
is the name of the
file created,
Fa name1
is the string
used in creating the symbolic link).
Either name may be an arbitrary path name; the files need not
be on the same file system.
RETURN VALUES
Upon successful completion, a zero value is returned.
If an error occurs, the error code is stored in
errno
and a -1 value is returned.
ERRORS
The symbolic link succeeds unless:
- Bq Er ENOTDIR
-
A component of the
Fa name2
prefix is not a directory.
- Bq Er ENAMETOOLONG
-
A component of a pathname exceeded
{NAME_MAX}
characters, or an entire path name exceeded
{PATH_MAX}
characters.
- Bq Er ENOENT
-
The named file does not exist.
- Bq Er EACCES
-
A component of the
Fa name2
path prefix denies search permission.
- Bq Er ELOOP
-
Too many symbolic links were encountered in translating the pathname.
- Bq Er EEXIST
-
Fa Name2
already exists.
- Bq Er EIO
-
An I/O error occurred while making the directory entry for
Fa name2 ,
or allocating the inode for
Fa name2 ,
or writing out the link contents of
Fa name2 .
- Bq Er EROFS
-
The file
Fa name2
would reside on a read-only file system.
- Bq Er ENOSPC
-
The directory in which the entry for the new symbolic link is being placed
cannot be extended because there is no space left on the file
system containing the directory.
- Bq Er ENOSPC
-
The new symbolic link cannot be created because there
there is no space left on the file
system that will contain the symbolic link.
- Bq Er ENOSPC
-
There are no free inodes on the file system on which the
symbolic link is being created.
- Bq Er EDQUOT
-
The directory in which the entry for the new symbolic link
is being placed cannot be extended because the
user's quota of disk blocks on the file system
containing the directory has been exhausted.
- Bq Er EDQUOT
-
The new symbolic link cannot be created because the user's
quota of disk blocks on the file system that will
contain the symbolic link has been exhausted.
- Bq Er EDQUOT
-
The user's quota of inodes on the file system on
which the symbolic link is being created has been exhausted.
- Bq Er EIO
-
An I/O error occurred while making the directory entry or allocating the inode.
- Bq Er EFAULT
-
Fa Name1
or
Fa name2
points outside the process's allocated address space.
SEE ALSO
link(2),
ln(1),
unlink(2)
HISTORY
The
Fn symlink
function call appeared in
BSD 4.2
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- ERRORS
-
- SEE ALSO
-
- HISTORY
-
This document was created by
man2html,
using the manual pages.
Time: 19:41:53 GMT, December 25, 2022